documenting release process #5252
Conversation
RELEASING.md
Outdated
| current state of master: `1-12-stable` | ||
|
|
||
| From that release branch, we create the first pre-release branch for that minor | ||
| version: `1-12-0-pre-1`. Until `1-12-0-pre-1` is ready for release, all active |
There was a problem hiding this comment.
we only do branches for the minor series -- there is no 1-12-0 branch, for example
[docs] consolidate all docs into sub folder 👋 goodness, that was a lot of typing! this is the first step of many for #5026. the only section that isn't complete with these changes is `RELEASING.md`, which is in progress in #5252 (those changes will be moved into the proper location if this PR goes in first). i made a few minor tweaks to the project's README to support this organization. i also left the code of conduct in the root. ~~one thing i *am concerned about* is that our little "guidelines for contributing" warning message on PRs is going to disappear after this gets merged because `CONTRIBUTING.md` is no longer in the root~~ ~~should i put a file in the root called `CONTRIBUTING.md` that links to the docs for contributing? 🤔 i'm not 100% sure on how the github integration for that works so y'all let me know.~~
[docs] consolidate all docs into sub folder 👋 goodness, that was a lot of typing! this is the first step of many for #5026. the only section that isn't complete with these changes is `RELEASING.md`, which is in progress in #5252 (those changes will be moved into the proper location if this PR goes in first). i made a few minor tweaks to the project's README to support this organization. i also left the code of conduct in the root. ~~one thing i *am concerned about* is that our little "guidelines for contributing" warning message on PRs is going to disappear after this gets merged because `CONTRIBUTING.md` is no longer in the root~~ ~~should i put a file in the root called `CONTRIBUTING.md` that links to the docs for contributing? 🤔 i'm not 100% sure on how the github integration for that works so y'all let me know.~~
|
ping @feministy |
We generally branch off
Since there is only one branch per minor version (
We generally use a GitHub issues milestone to track releases, but we don't have a lot of formal tracking: https://github.com/bundler/bundler/milestones
Slack is easiest, and users can invite themselves at slack.bundler.io, but we also have a shared email address: team@bundler.io.
Not yet, but I started working on something to automate new releases on the website, and it has a template for the "what's new" page in it: rubygems/bundler-site#307 |
|
What’s the status here. Is this PR still being worked on? |
|
@schneems I have not had time to devote to this PR, everything I have pushed up so far is all of the work I've done. If someone wants to take it over, that's ok with me! |
|
I've just updated this, I'd greatly appreciate some review ❤️ |
segiddins
changed the title
| @@ -1,9 +1,147 @@ | |||
| # Releasing | |||
|
|
|||
| _Release process documentation is in progress, see [PR 5252](https://github.com/bundler/bundler/pull/5252)._ | |||
| Bundler users [Semantic Versioning](https://semver.org/). | |||
| PR, section, author(s), issue(s) closed, and message. | ||
|
|
||
| Ensure that repo has been updated with all new PRs before releasing a new version, | ||
| and copy over the new sections to the `CHANGELOG.md` in the Bundler repo. |
There was a problem hiding this comment.
How does one update that repo? I honestly don't remember, and that repo doesn't have a readme. 😭
There was a problem hiding this comment.
uh, I haven't done so since my last release. want to open an issue there for someone to add a README ?
|
@bundlerbot r+ |
|
📌 Commit 05819a2 has been approved by |
documenting release process refs #4135 I took the comments from @segiddins, @lynnco, and @indirect and organized them with a little extra prose where I saw fit. It's mostly y'alls words, just reorganized 😊 There are a few questions I have, mostly about branching: - When `1.12.pre.1` is released, is it merged to `1-12-stable`? - If there are bugs in `1.12.pre.1` *and* the branch (`1-12-pre-1`) is merged to master, is the branch for `1.12.pre.2` a branch off of `1-12-stable`? - Are there any places we can reference to follow on discussions about in progress features, roadmaps, planned work, etc? It might be a good place to reference some of that stuff - How can people get in touch with the core team? - Is there a template for blog posts? A few things to note: - In the notes on the issue, it looks like you flop between using `.` versus `-` as the delimiter in your branch names. I went with `-` since that appears to be what you're using in the repo itself - I do the full Github links so when people pull it down locally, they have the reference to the full link locally instead of relying on Github's magic linking
|
☀️ Test successful - status-travis |
refs #4135
I took the comments from @segiddins, @lynnco, and @indirect and organized them with a little extra prose where I saw fit. It's mostly y'alls words, just reorganized 😊
There are a few questions I have, mostly about branching:
1.12.pre.1is released, is it merged to1-12-stable?1.12.pre.1and the branch (1-12-pre-1) is merged to master, is the branch for1.12.pre.2a branch off of1-12-stable?A few things to note:
.versus-as the delimiter in your branch names. I went with-since that appears to be what you're using in the repo itself